Conversation
nikolasdehor
left a comment
There was a problem hiding this comment.
The intent is good — having a standardized AGENTS.md for AI coding agents to follow is useful. However, this file is quite sparse for its purpose. A few suggestions:
-
Add project-specific context. The current rules are generic enough to apply to any repo. An
AGENTS.mdis most useful when it captures project-specific conventions:- Go version requirement (1.25+)
make checkrunsgofmt,go vet, andgo test— mention this- Conventional commit format for commit messages
- Config changes should go through
pkg/config/defaults.gonot manual JSON - Security-sensitive areas: auth providers, channel allowlists, exec tool
- Test patterns: table-driven tests,
httptestfor channel handlers
-
make testmay not be sufficient. The project usesmake checkwhich includesgofmtandgo vetin addition to tests. Consider specifyingmake checkinstead. -
Consider adding a "do not" section. E.g.:
- Do not add new dependencies without justification
- Do not modify
go.summanually - Do not expose config tokens/keys in error messages or logs
As-is, the content is correct but would benefit from being more actionable and project-specific. Not blocking since any AGENTS.md is better than none.
|
|
📝 Description
Add
AGENTS.mdto capture the agent working agreement so everyone—humans or AI assistants—consistently follows the same coding standards, documentation expectations, testing requirements, and themake testgate after any change.🗣️ Type of Change
🤖 AI Code Generation
🔗 Related Issue
📚 Technical Context (Skip for Docs)
make testafter changes.🧪 Test Environment